All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.media.j3d.Soundscape

java.lang.Object
   |
   +----javax.media.j3d.SceneGraphObject
           |
           +----javax.media.j3d.Node
                   |
                   +----javax.media.j3d.Leaf
                           |
                           +----javax.media.j3d.Soundscape

public class Soundscape

extends Leaf

The Soundscape application region, different from a Sound node's scheduling region, is used to select which Soundscape (and thus which aural attribute object) is to be applied to the sounds being rendered. This selection is based on the position of the ViewPlatform (i.e., the listener), not the position of the sound.

It will be common that multiple Soundscape regions are contained within a scene graph. For example, two Soundscape regions within a single space the listener can move about: a region with a large open area on the right, and a smaller more constricted, less reverberant area on the left. The rever- beration attributes for these two regions could be set to approximate their physical differences so that active sounds are rendered differently depending on which region the listener is in.

ALLOW_APPLICATION_BOUNDS_READ

For Soundscape component objects, specifies that this object allows read access to its application bounds

ALLOW_APPLICATION_BOUNDS_WRITE

For Soundscape component objects, specifies that this object allows write access to its application bounds

ALLOW_ATTRIBUTES_READ

For Soundscape component objects, specifies that this object allows the reading of it's aural attributes information

ALLOW_ATTRIBUTES_WRITE

For Soundscape component objects, specifies that this object allows the writing of it's aural attribute information

Soundscape()

Constructs and initializes a new Sound node using following defaults:

application region: null (no active region)

aural attributes: null (uses default aural attributes)

Soundscape(Bounds, AuralAttributes)

Constructs and initializes a new Sound node using specified parameters

getApplicationBoundingLeaf()

Retrieves the Soundscape node's application bounding leaf.

getApplicationBounds()

Retrieves the Soundscape node's application bounds.

getAuralAttributes()

Retrieve reference of Aural Attributes

setApplicationBoundingLeaf(BoundingLeaf)

Set the Soundscape's application region to the specified bounding leaf.

setApplicationBounds(Bounds)

Set the Soundscape's application region to the specified bounds specified in local coordinates of this leaf node.

setAuralAttributes(AuralAttributes)

Set a set of aural attributes for this Soundscape

 public static final int ALLOW_APPLICATION_BOUNDS_READ

For Soundscape component objects, specifies that this object allows read access to its application bounds

 public static final int ALLOW_APPLICATION_BOUNDS_WRITE

For Soundscape component objects, specifies that this object allows write access to its application bounds

 public static final int ALLOW_ATTRIBUTES_READ

For Soundscape component objects, specifies that this object allows the reading of it's aural attributes information

 public static final int ALLOW_ATTRIBUTES_WRITE

For Soundscape component objects, specifies that this object allows the writing of it's aural attribute information

 public Soundscape()

Constructs and initializes a new Sound node using following defaults:

application region: null (no active region)

aural attributes: null (uses default aural attributes)

 public Soundscape(Bounds region,
                   AuralAttributes attributes)

Constructs and initializes a new Sound node using specified parameters

Parameters:

region - application region

attributes - array of aural attribute component objects

 public final void setApplicationBounds(Bounds region)

Set the Soundscape's application region to the specified bounds specified in local coordinates of this leaf node. The aural attributes associated with this Soundscape are used to render the active sounds when this application region intersects the ViewPlatform's activation volume. The getApplicationBounds method returns a new Bounds object. This region is used when the application bounding leaf is null.

Parameters:

region - the bounds that contains the Soundscape's new application region.

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final Bounds getApplicationBounds()

Retrieves the Soundscape node's application bounds.

Returns:

this Soundscape's application bounds information

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setApplicationBoundingLeaf(BoundingLeaf region)

Set the Soundscape's application region to the specified bounding leaf. When set to a value other than null, this overrides the application bounds object.

Parameters:

region - the bounding leaf node used to specify the Soundscape node's new application region.

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final BoundingLeaf getApplicationBoundingLeaf()

Retrieves the Soundscape node's application bounding leaf.

Returns:

this Soundscape's application bounding leaf information

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setAuralAttributes(AuralAttributes attributes)

Set a set of aural attributes for this Soundscape

Parameters:

attributes - aural attributes

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final AuralAttributes getAuralAttributes()

Retrieve reference of Aural Attributes

Returns:

reference to aural attributes

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

All Packages  Class Hierarchy  This Package  Previous  Next  Index